home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / lndl27.zip / FTS-0005.ZIP / FTS-0005.TXT
Text File  |  1989-02-05  |  18KB  |  503 lines
  1. FTS-0005
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                         The Distribution Nodelist
  8.  
  9.  
  10.                 Original by Ben Baker,  7:44/76@AlterNet
  11.                 Amended by Rick Moore,  1:115/333@FidoNet
  12.                             February 5,  1989
  13.  
  14.  
  15.  
  16. Copyright 1986,  1987,  1988,  1989 by the International FidoNet
  17. Association.  All rights reserved.  Duplication and/or distribution
  18. permitted for non-commercial purposes only.
  19.  
  20. This document supercedes and replaces the document known under the names
  21. of FSC002,  FSC-0002,  and FTS-0002.
  22.  
  23. This document defines the format and content of the nodelist for the
  24. Public FidoNet Network (PFN) as published each Friday.
  25.  
  26. The PFN is an international network of independently owned electronic
  27. mail systems,  most with interlocking electronic bulletin board systems. 
  28. The distribution nodelist,  or simply "nodelist",  is the glue which
  29. holds the network together.  It is the PFN's "phone book" and it defines
  30. the top-level network structure.
  31.  
  32. The nodelist is published as an ASCII text file named NODELIST.nnn, 
  33. where nnn is the day-of-year of the Friday publication date.  This file
  34. is packed into an standard archive file (using System Enhancement
  35. Associates' ARC file format) named NODELIST.Ann,  where nn are the last
  36. two digits of day-of-year.
  37.  
  38. A companion file,  COORD.nnn,  lists the coordinators of the various
  39. regions and local networks which constitute the PFN.  This file may be
  40. created from NODELIST.nnn by the program COORD.EXE,  distributed by many
  41. PFN bulletin boards.
  42.  
  43. As stated above,  NODELIST.nnn is an ASCII text file.  It contains two
  44. kinds of lines,  comment lines and data lines.  Each line is terminated
  45. with an ASCII carriage return and line feed character sequence,  and
  46. contains no trailing white-space (spaces, tabs, etc.).  The file is
  47. terminated with an end-of-file character (EOF = decimal character value
  48. 26).
  49.  
  50. Comments lines contain a semicolon (;) in the first character position
  51. followed by zero or more alphabetic characters called "interest flags". 
  52. A program which processes the nodelist may use comment interest flags to
  53. determine the disposition of a comment line.  The remainder of a comment
  54. line (with one exception,  treated below) is free-form ASCII text. 
  55. There are five interest flags defined as follows:
  56.  
  57.      ;S This comment is of particular interest to Sysops.
  58.  
  59.      ;U This comment is of particular interest to BBS users.
  60.  
  61.                                     1
  62. FTS-0005
  63.  
  64.  
  65.  
  66.  
  67.  
  68.      ;F This comment should appear in any formatted "Fido List".
  69.  
  70.      ;A This comment is of general interest (shorthand for ;SUF).
  71.  
  72.      ;E This comment is an error message inserted by the nodelist
  73.           generating program MakeNL.
  74.  
  75.      ; This comment may be ignored by a nodelist processor.
  76.  
  77. The first line of a nodelist is a special comment line containing
  78. identification data for the particular edition of the nodelist.  The
  79. following is an example of the first line of a nodelist:
  80.  
  81. ;A FidoNet Nodelist for Friday, July 3, 1987 --
  82.      Day number 184 : 15943
  83.  
  84. This line contains the general interest flag,  the day,  date,  and
  85. day-of-year number of publication,  and ends with a 5-digit decimal
  86. number with leading zeros,  if necessary.  This number is the decimal
  87. representation of a check value derived as follows:
  88.  
  89.      Beginning with the first character of the second line,  a 16-bit
  90.      cyclic redundancy check (CRC) is calculated for the entire file,
  91.      including carriage return and line feed characters,  but not
  92.      including the terminating EOF character.  The check polynomial used
  93.      is the same one used for many file transfer protocols:
  94.  
  95.           2**16 + 2**12 + 2**5 + 2**0
  96.  
  97. The CRC may be used to verify that the file has not been edited.  The
  98. importance of this will become evident in the discussion of NODEDIFF, 
  99. below.  CRC calculation techniques are well documented in the
  100. literature,  and will not be treated further here.
  101.  
  102. The content of the remaining comments in the nodelist are intended to be
  103. informative.  Beyond the use of interest flags for distribution,  a
  104. processing program need not have any interest in them.
  105.  
  106. A nodelist data line contains eight variable length "fields" separated
  107. by commas (,).  No space characters are allowed in a data line,  and
  108. underscore characters are used in lieu of spaces.  The term
  109. "alphanumeric character" is defined as the portion of the ASCII
  110. character set from 20 hex through 7E hex,  inclusive.  The following
  111. discussion defines the contents of each field in a data line.
  112.  
  113.  
  114. Field 1: Keyword
  115.  
  116. The keyword field may be empty,  or may contain one of the following:
  117.  
  118.      Zone  --
  119.           Begins the definition of a geographic zone and define its
  120.           coordinator.  All the data lines following a line with the
  121.           "Zone" keyword down to,  but not including,  the next
  122.  
  123.  
  124.                                     2
  125. FTS-0005
  126.  
  127.  
  128.  
  129.           occurrence of a "Zone" keyword,  are regions,  networks,  and
  130.           nodes within the defined zone.
  131.  
  132.      Region --
  133.           Begins the definition of a geographic region and defines its
  134.           coordinator.  All the data lines following a line with the
  135.           "Region" keyword down to,  but not including,  the next
  136.           occurrence of a "Zone",  "Region",  or "Host" keyword, are
  137.           independent nodes within the defined region.
  138.  
  139.      Host --
  140.           Begins the definition of a local network and defines its host. 
  141.           All the data lines following a line with the Host keyword down
  142.           to,  but not including,  the next occurrence of a "Zone", 
  143.           "Region",  or "Host" keyword,  are local nodes,  members of
  144.           the defined local network.
  145.  
  146.      Hub --
  147.           Begins the definition of a routing subunit within a multilevel
  148.           local network.  The hub is the routing focal point for nodes
  149.           listed below it until the next occurrence of a "Zone", 
  150.           "Region",  "Host",  or "Hub" keyword.  The hub entry MUST be a
  151.           redundant entry,  with a unique number,  for one of the nodes
  152.           listed below it.  This is necessary because some nodelist
  153.           processors eliminate these entries in all but the local
  154.           network.
  155.  
  156.      Pvt --
  157.           Defines a private node with unlisted number.  Private nodes
  158.           are only allowed as members of local networks.
  159.  
  160.      Hold --
  161.           Defines a node which is temporarily down.  Mail may be sent to
  162.           it and is held by its host or coordinator.
  163.  
  164.      Down --
  165.           Defines a node which is not operational.  Mail may NOT be sent 
  166.           to it.  This keyword may not be used for longer than two weeks
  167.           on any single node,  at which point the "down" node is to be
  168.           removed from the nodelist.
  169.  
  170.      <empty> --
  171.           Defines a normal node entry.
  172.  
  173. Field 2 - Zone/Region/Net/Node number
  174.  
  175.      This field contains only numeric digits and is a number in the
  176.      range of 0 to 32767.  If the line had the "Zone",  "Region",  or
  177.      "Host" keyword,  the number is the zone,  net,  or region number, 
  178.      and the node has an implied node number of 0.  Otherwise,  the
  179.      number is the node number.  The zone number,  region or net number, 
  180.      and the node number,  taken together,  constitute a node's FidoNet
  181.      address.
  182.  
  183.      Zone numbers must be unique.  Region or net numbers must be unique
  184.      within their zone.  Hub numbers must be within their net.  Node
  185.  
  186.  
  187.                                     3
  188. FTS-0005
  189.  
  190.  
  191.  
  192.  
  193.      numbers must be unique within their region (for regional
  194.      independents) or net (for members of a local network).  Duplicate
  195.      node numbers under different hubs within the same net are not
  196.      allowed.
  197.  
  198. Field 3 - Node name
  199.  
  200.      This field may contain any alphanumeric characters other than
  201.      commas and spaces.  Underscores are used to represent spaces.  This
  202.      is the name by which the node is known.
  203.  
  204. Field 4 - Location
  205.  
  206.      This field may contain any alphanumeric characters other than
  207.      commas and spaces